Mute Channel
Mute notifications for a specific channel.
Authentication Required
Login to swap the placeholders with your real Instance ID and Access Token.
Log InNo query parameters required
This endpoint doesn't expect data in the URL.
Silence is Golden: Muting Channels
The /v2/channels/{id}/mute endpoint allows you to programmatically silence notifications for a specific channel. This corresponds to the "Mute" action in the mobile app.
🔇 What Does "Mute" Actually Do?
It is important to understand the distinction between "Muting" and "Unfollowing".
1. Webhook delivery
Muting does NOT stop webhooks.
- Even if a channel is muted, your Wawp instance will still receive every new message via the
messagewebhook event. - Why? The API assumes that if you are following a channel programmatically, you want the data for processing, regardless of whether you want the phone to ring.
2. Device Behavior
- Notifications: The connected physical phone (if any) will stop vibrating/ringing for new updates from this channel.
- Badge Count: New messages will not increment the unread badge count on the main "Updates" tab icon, reducing visual clutter.
- Sorting: Muted channels are often pushed to the bottom of the list in the mobile UI.
🎯 Use Cases
The "Silent Collector" Bot
You are building a market research tool that follows 500 news channels.
- Problem: If you don't mute them, the phone connected to the Wawp instance will crash or drain its battery due to thousands of push notifications per hour.
- Solution: Immediately after calling
/follow, tips: [ { type: 'info', title: 'User Experience', content: 'Muting stops push notifications but keeps the channel in the list.' }, { type: 'info', title: 'Default', content: 'New follows are often muted by default unless the user opts in.' } ], recommendations: [ "Respect user preference; do not auto-unmute.", "Suggest muting for high-volume channels to prevent notification fatigue." ]
call /mute. This keeps the phone cool while your server happily ingests the data stream.
Request Parameters
Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.
Request Body
Sent as a JSON objectstring | Your unique WhatsApp Instance ID Example: | ||
string | Your API Access Token Example: | ||
string | The unique ID of the channel Example: |
Request Samples
Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.
Expected Responses
Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.
Example
{
"status": "success",
"message": "Channel muted"
}Command Palette
Search for a command to run...